/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.pool2;

import java.io.Closeable;
import java.util.NoSuchElementException;

/**
 * A pooling simple interface.
 * <p>
 * Example of use:
 * </p>
 * <pre style="border:solid thin; padding: 1ex;"
 * > Object obj = <code style="color:#00C">null</code>;
 *
 * <code style="color:#00C">try</code> {
 * obj = pool.borrowObject();
 * <code style="color:#00C">try</code> {
 * <code style="color:#0C0">//...use the object...</code>
 * } <code style="color:#00C">catch</code> (Exception e) {
 * <code style="color:#0C0">// invalidate the object</code>
 * pool.invalidateObject(obj);
 * <code style="color:#0C0">// do not return the object to the pool twice</code>
 * obj = <code style="color:#00C">null</code>;
 * } <code style="color:#00C">finally</code> {
 * <code style="color:#0C0">// make sure the object is returned to the pool</code>
 * <code style="color:#00C">if</code> (<code style="color:#00C">null</code> != obj) {
 * pool.returnObject(obj);
 * }
 * }
 * } <code style="color:#00C">catch</code>(Exception e) {
 * <code style="color:#0C0">// failed to borrow an object</code>
 * }</pre>
 * <p>
 * See {@link BaseObjectPool} for a simple base implementation.
 * </p>
 * <p>
 * 对象池的核心接口叫做ObjectPool，他定义了对象池的应该实现的行为
 *
 * @param <T> Type of element pooled in this pool.
 * @see PooledObjectFactory
 * @see KeyedObjectPool
 * @see BaseObjectPool
 * @since 2.0
 */
public interface ObjectPool<T> extends Closeable {


    /**
     * 往池中添加一个对象。池子里的所有对象都是通过这个方法进来的
     */
    void addObject() throws Exception;

    default void addObjects(final int count) throws Exception {
        for (int i = 0; i < count; i++) {
            addObject();
        }
    }


    /**
     * 从池中借走到一个对象。借走不等于删除。对象一直都属于池子，只是状态的变化
     * 从池里返回的实例既可能是一个新创建的对象，也可能是之前创建的但是当前未被使用的空闲对象。
     * <p>
     * 返回的对象将会通过PooledObjectFactory的activateObject方法进行激活，然后通过PooledObjectFactory的validateObject方法进行校验有效性。
     * 根据约定，客户端必须通过调用returnObject（正常归还）、invalidateObject（销毁实例）来达到归还实例的目的。或者（约定之外）通过定义在子类中的相关实现方法进行归还。
     * 这个方法并没有强制规定当对象池耗尽的时候到底应该如何处理（是抛异常呢，还是无限等待呢，还是返回空呢），子类可以有自定义实现
     */
    T borrowObject() throws Exception;


    /**
     * 清理对象池。注意是清理不是清空，改方法要求的是，清理所有空闲对象，释放相关资源
     */
    void clear() throws Exception;


    /**
     * 关闭对象池。这个方法可以达到清空的效果，清理所有对象以及相关资源
     */
    @Override
    void close();


    /**
     * 返回对象池中有对象对象是活跃的，也就是已经被借走的，在使用中的对象的数量
     */
    int getNumActive();

    /**
     * 返回对象池中有多少对象是空闲的，也就是能够被借走的对象的数量。
     */
    int getNumIdle();

    /**
     * 销毁一个对象。这个方法才会将对象从池子中删除，当然这其中最重要的就是释放对象本身持有的各种资源。
     */
    void invalidateObject(T obj) throws Exception;


    default void invalidateObject(final T obj, final DestroyMode destroyMode) throws Exception {
        invalidateObject(obj);
    }

    /**
     * 把对象归还给对象池。归还不等于添加。对象一直都属于池子，只是状态的变化
     */
    void returnObject(T obj) throws Exception;

}
